feat: Add LLMs.txt to help AI agents understand the library#348
feat: Add LLMs.txt to help AI agents understand the library#348Sigmabrogz wants to merge 3 commits intotoss:mainfrom
LLMs.txt to help AI agents understand the library#348Conversation
Closes toss#280 Adds an `LLMs.txt` file at the root of the project to help AI agents (like Cursor, Copilot) understand the library and its available hooks, rather than reinventing them. Lists available hooks in `@react-simplikit/core` and `@react-simplikit/mobile`.
|
Hi, this PR adds LLMs.txt to help AI agents understand the library. Ready for review when you have time. Thanks! |
|
Thanks for this contribution! This addresses #280 and is a great DX improvement for AI agents. I noticed a few things that would make this even better:
Also, we're planning to try geo-seo-claude for generating AI-optimized Looking forward to the updates! |
|
I've updated the |
|
Thanks for the quick updates! A few more small things I noticed:
|
|
Done! Renamed the file to |
Summary
Adds an
LLMs.txtfile at the root of the project to outline the library's features and hooks for AI agents like Cursor or Copilot, so they avoid reinventing the wheel and use the built-in hooks.Problem
Closes #280
Solution
Created an
LLMs.txtfile detailing the purpose, installation, and listing all hooks with a short description inpackages/core/src/hooksand mentioningpackages/mobile.Testing
Checklist